----------------------------------------------------------------------
Source files of the boosting library described in
  The Engineering of a Compression Boosting Library:
  Theory vs Practice in BWT compression
  by P. Ferragina, R. Giancarlo, and G. Manzini
submitted to ESA '06 engineering/applications track
---------------------------------------------------------------------- 



To test the boosting algorithms described in the ESA submission:

1) Type 
     make 
   (no arguments) to compile the source files 

2) Type 
     bst file_name [options]
   to compress file_name and produce the compressed file file_name.bst

   Type 
     unbst file_name.bst 
   to uncompress the file producing file_name.bst.y which will be
   hopefully identical to the original file.


The options to be used for each algorithm are as follows:
     

MtfRleMth
bst -a6 -fm 

RleRc fast
bst -a7 -f -y65536 -z256 

MtfRleRc fast
bst -a8 -fm -y65536 -z256 

BoostRleRc fast
bst -a7 -c1 -y65536 -z256 

RleRc med
bst -a7 -f -y65536 -z32 

MtfRleRc med
bst -a8 -fm -y65536 -z32 

BoostRleRc med
bst -a7 -c1 -y65536 -z32 

RleRc slow
bst -a7 -f -y65536 -z4 

MtfRleRc slow
bst -a8 -fm -y65536 -z4 

BoostRleRc slow
bst -a7 -c1 -y65536 -z4 

RleAc fast
bst -a1 -f -y16384 -z64 

MtfRleAc fast
bst -a2 -fm -y16384 -z64 

BoostRleAc fast
bst -a1 -c1 -y16384 -z64 

RleHuff
bst -a10 -f 

MtfRleHuff
bst -a11 -fm 

BoostRleHuff
bst -a10 -c1 

Wavelet
bst -a4 -f 

BoostWav
bst -a4 -c1 

BoostRleRc Fast \mu=32
bst -a7 -c0 -y65536 -z256 -x32 

BoostRleHuff \mu=32
bst -a10 -c0 -x32


NOTE1: adding -v or -vv at the end of the options produces additional info on
the compression process. 


NOTE2: the script btest compresses, decompresses a file checking that
       the uncopressed file is identical to the original. The usage is
          btest file_name [options]    


NOTE3: the script DCtest0 can be used to test all algorithms on
a collection of files. To do this: 
  1) put your test files in a subdirectory (e.g. mycorpus)
  2) in mycorpus create a .index file containing the names of the
     test files (one file name per line)
  3) type DCtest0 bst mycorpus ESA_test &
  4) at the end of the experiment a bst.ris file is created containing 
     a (latex format) table reporting for each compressor: 
       the compression ratio for each file,
       the average compression ratio, 
       average compression and decompression times.
       (all tables in the submitted paper have been created this way)  
To test the booster with the entropy bound model, at step 3 type    
   DCtest0 bst mycorpus ESA_test_entropybound &


NOTE4: Instructions for using the library for boosting an arbitrary order zero
compressor are given in the README file.

